Skip to content

Update README.md #378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 29, 2025
Merged

Update README.md #378

merged 1 commit into from
Sep 29, 2025

Conversation

omrialmog
Copy link
Collaborator

@omrialmog omrialmog commented Sep 25, 2025 •
edited by coderabbitai bot
Loading

What does this PR do?

Type of change: ?

Overview: ?

Usage

# Add a code snippet demonstrating how to use this

Testing

Before your PR is "Ready for review"

  • Make sure you read and follow Contributor guidelines and your commits are signed.
  • Is this change backward compatible?: Yes/No
  • Did you write any new necessary tests?: Yes/No
  • Did you add or update any necessary documentation?: Yes/No
  • Did you update Changelog?: Yes/No

Additional Information

Summary by CodeRabbit

  • Documentation
    • Updated README introduction: removed the leading article and retained bold emphasis on the product name.
    • Polished opening sentence for clarity, consistency, and style; standardized tone and formatting.
    • Improves readability and first impressions for new users browsing the project documentation.
    • No functional changes to the product.

@omrialmog
Update README.md
58356e0 
Signed-off-by: omrialmog <[email protected]>
@omrialmog omrialmog requested a review from a team as a code owner September 25, 2025 22:17
@omrialmog omrialmog requested a review from RalphMao September 25, 2025 22:17
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Sep 25, 2025 •
edited
Loading

Walkthrough

Edited README.md opening sentence by removing the leading article and adjusting bold emphasis around the product name. No content, logic, or structural changes beyond this textual modification.

Changes

Cohort / File(s) Summary
Docs: README wording tweak
README.md		 Removed the initial article "The" and adjusted surrounding bold formatting in the first sentence; no semantic change elsewhere.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I hopped through docs with careful tread,
A tiny tweak at sentence head—
Snipped “The,” bold stayed, the meaning true,
A nibble of text, and on I flew.
Thump-thump! README’s crisp anew. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title “Update README.md” accurately indicates that the README file was modified and thus relates to the actual change, even though it does not specify the exact edit; it therefore meets the criteria for a partially related title.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch omrialmog-patch-1
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b4d6ced and 58356e0.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-16T20:14:34.768Z 
Learnt from: realAsma
PR: NVIDIA/TensorRT-Model-Optimizer#318
File: modelopt/torch/quantization/plugins/transformers_trainer.py:191-191
Timestamp: 2025-09-16T20:14:34.768Z
Learning: The TensorRT-Model-Optimizer project only supports PyTorch >= 2.6, so using the `weights_only` parameter in torch.load calls is acceptable and doesn't require backward compatibility handling.

Applied to files:

  • README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: linux
  • GitHub Check: build-docs
  • GitHub Check: code-quality
🔇 Additional comments (1)
README.md (1)

18-18: Intro wording tweak looks good

Dropping the leading article reads cleaner without changing meaning. Thanks for the tidy-up.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov Codecov
Copy link

codecov bot commented Sep 25, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.45%. Comparing base (b4d6ced) to head (58356e0).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #378   +/-   ##
=======================================
  Coverage   73.45%   73.45%           
=======================================
  Files         172      172           
  Lines       17645    17645           
=======================================
  Hits        12961    12961           
  Misses       4684     4684

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kevalmorabia97 kevalmorabia97 merged commit 677bc10 into main Sep 29, 2025
27 checks passed
@kevalmorabia97 kevalmorabia97 deleted the omrialmog-patch-1 branch September 29, 2025 19:42
kevalmorabia97 pushed a commit that referenced this pull request Oct 1, 2025
@omrialmog @kevalmorabia97
Update README.md (#378)
a955552 
Signed-off-by: omrialmog <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kevalmorabia97 kevalmorabia97 kevalmorabia97 approved these changes

@RalphMao RalphMao Awaiting requested review from RalphMao RalphMao is a code owner automatically assigned from NVIDIA/modelopt-examples-codeowners

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@omrialmog @kevalmorabia97